<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>JSON Voorhees: jsonv::object_node_handle Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="http://www.mathjax.org/mathjax/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">JSON Voorhees
   </div>
   <div id="projectbrief">Killer JSON for C++</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classjsonv_1_1object__node__handle.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classjsonv_1_1object__node__handle-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">jsonv::object_node_handle Class Reference<span class="mlabels"><span class="mlabel">final</span></span><div class="ingroups"><a class="el" href="group__Value.html">Value</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>A <a href="http://en.cppreference.com/w/cpp/container/node_handle">node handle</a> used when a value is kind::object to access elements of the object in potentially destructive manner.  
 <a href="classjsonv_1_1object__node__handle.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="value_8hpp_source.html">jsonv/value.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:abce52f2f8223c29d4db00db9b7d6b89f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abce52f2f8223c29d4db00db9b7d6b89f"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjsonv_1_1object__node__handle.html#abce52f2f8223c29d4db00db9b7d6b89f">key_type</a> = std::string</td></tr>
<tr class="memdesc:abce52f2f8223c29d4db00db9b7d6b89f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The key type of the object. <br/></td></tr>
<tr class="separator:abce52f2f8223c29d4db00db9b7d6b89f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a781a953c0ef0ed595bfbafa860771c86"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a781a953c0ef0ed595bfbafa860771c86"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjsonv_1_1object__node__handle.html#a781a953c0ef0ed595bfbafa860771c86">mapped_type</a> = <a class="el" href="classjsonv_1_1value.html">value</a></td></tr>
<tr class="memdesc:a781a953c0ef0ed595bfbafa860771c86"><td class="mdescLeft">&#160;</td><td class="mdescRight">The mapped type of the object. <br/></td></tr>
<tr class="separator:a781a953c0ef0ed595bfbafa860771c86"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac7d95dc14368ef1a8fffe8de711e318f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7d95dc14368ef1a8fffe8de711e318f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>object_node_handle</b> (<a class="el" href="classjsonv_1_1object__node__handle.html">object_node_handle</a> &amp;&amp;) noexcept</td></tr>
<tr class="separator:ac7d95dc14368ef1a8fffe8de711e318f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ebb29e3d7194f34b07a7ebfd4e5a765"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ebb29e3d7194f34b07a7ebfd4e5a765"></a>
<a class="el" href="classjsonv_1_1object__node__handle.html">object_node_handle</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classjsonv_1_1object__node__handle.html">object_node_handle</a> &amp;&amp;) noexcept</td></tr>
<tr class="separator:a2ebb29e3d7194f34b07a7ebfd4e5a765"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a830e189a6c1a445d09164750e12f4414"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjsonv_1_1object__node__handle.html#a830e189a6c1a445d09164750e12f4414">empty</a> () const noexcept</td></tr>
<tr class="separator:a830e189a6c1a445d09164750e12f4414"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4617068ac791997462bfd83405c5fbca"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjsonv_1_1object__node__handle.html#a4617068ac791997462bfd83405c5fbca">operator bool</a> () const noexcept</td></tr>
<tr class="separator:a4617068ac791997462bfd83405c5fbca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4893a733d2cab30f45421d02427a1abd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classjsonv_1_1object__node__handle.html#abce52f2f8223c29d4db00db9b7d6b89f">key_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjsonv_1_1object__node__handle.html#a4893a733d2cab30f45421d02427a1abd">key</a> () const </td></tr>
<tr class="memdesc:a4893a733d2cab30f45421d02427a1abd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a non-const reference to the <a class="el" href="classjsonv_1_1object__node__handle.html#abce52f2f8223c29d4db00db9b7d6b89f">key_type</a> member of the element.  <a href="#a4893a733d2cab30f45421d02427a1abd">More...</a><br/></td></tr>
<tr class="separator:a4893a733d2cab30f45421d02427a1abd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21e4867fe822e9bb8194ead29022ad5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classjsonv_1_1object__node__handle.html#a781a953c0ef0ed595bfbafa860771c86">mapped_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjsonv_1_1object__node__handle.html#a21e4867fe822e9bb8194ead29022ad5e">mapped</a> () const </td></tr>
<tr class="memdesc:a21e4867fe822e9bb8194ead29022ad5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a non-const reference to the <a class="el" href="classjsonv_1_1object__node__handle.html#a781a953c0ef0ed595bfbafa860771c86">mapped_type</a> member of the element.  <a href="#a21e4867fe822e9bb8194ead29022ad5e">More...</a><br/></td></tr>
<tr class="separator:a21e4867fe822e9bb8194ead29022ad5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ae5cda98fa74051d037c0c444c67efb15"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae5cda98fa74051d037c0c444c67efb15"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
<tr class="separator:ae5cda98fa74051d037c0c444c67efb15"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A <a href="http://en.cppreference.com/w/cpp/container/node_handle">node handle</a> used when a value is kind::object to access elements of the object in potentially destructive manner. </p>
<p>This makes it possible to modify the contents of a node extracted from an object, and then re-insert it without having to copy the element. </p>

<p>Definition at line <a class="el" href="value_8hpp_source.html#l01048">1048</a> of file <a class="el" href="value_8hpp_source.html">value.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a830e189a6c1a445d09164750e12f4414"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool jsonv::object_node_handle::empty </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the node handle is empty; <code>false</code> if otherwise. </dd></dl>

<p>Definition at line <a class="el" href="value_8hpp_source.html#l01069">1069</a> of file <a class="el" href="value_8hpp_source.html">value.hpp</a>.</p>

</div>
</div>
<a class="anchor" id="a4893a733d2cab30f45421d02427a1abd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classjsonv_1_1object__node__handle.html#abce52f2f8223c29d4db00db9b7d6b89f">key_type</a>&amp; jsonv::object_node_handle::key </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a non-const reference to the <a class="el" href="classjsonv_1_1object__node__handle.html#abce52f2f8223c29d4db00db9b7d6b89f">key_type</a> member of the element. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">std::invalid_argument</td><td>if the node handle is <a class="el" href="classjsonv_1_1object__node__handle.html#a830e189a6c1a445d09164750e12f4414">empty</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a21e4867fe822e9bb8194ead29022ad5e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classjsonv_1_1object__node__handle.html#a781a953c0ef0ed595bfbafa860771c86">mapped_type</a>&amp; jsonv::object_node_handle::mapped </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a non-const reference to the <a class="el" href="classjsonv_1_1object__node__handle.html#a781a953c0ef0ed595bfbafa860771c86">mapped_type</a> member of the element. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">std::invalid_argument</td><td>if the node handle is <a class="el" href="classjsonv_1_1object__node__handle.html#a830e189a6c1a445d09164750e12f4414">empty</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a4617068ac791997462bfd83405c5fbca"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">jsonv::object_node_handle::operator bool </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd><code>false</code> if the node handle is empty; <code>true</code> if otherwise. </dd></dl>

<p>Definition at line <a class="el" href="value_8hpp_source.html#l01072">1072</a> of file <a class="el" href="value_8hpp_source.html">value.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>jsonv/<a class="el" href="value_8hpp_source.html">value.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>jsonv</b></li><li class="navelem"><a class="el" href="classjsonv_1_1object__node__handle.html">object_node_handle</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
